Upgrade Notes
Note: Sapphire 1.5.2 has been relabelled Sapphire 9.0. Details here.
IMPORTANT!
If you are upgrading Sapphire in an environment alongside EMu 9.0 or later, DO NOT use these upgrade notes.
From EMu 9.0 onwards, Sapphire is bundled with EMu and the upgrade notes on the EMu Support site must be used.
-
HTTP Server:
-
PHP:
- Version 5.0 or later
- DOM Extension for PHP
- Latest Sapphire release
Sapphire is designed to allow multiple installations to coexist. Each installation is placed in a directory and the name of this directory typically reflects the version of Sapphire being installed:
Sapphire should be installed as the same user as the previous version of Sapphire. The following covers an installation for user imu
:
- Login as user
imu
- Install Sapphire:
cd sapphire
mkdir sapphire-1.5.2
tar xzf sapphire-1.5.2.tgz sapphire-1.5.2
rm latest
ln -s sapphire-1.5.2 latest
- Modify the sapphire
index.html
file for improved response times:cd sapphire-1.5.2
vim index.html
- Find the following line:
<script type=”text/javascript” src=”imu/imu.php”></script>
and change
php
tojs
:<script type=”text/javascript” src=”imu/imu.js”></script>
- Configure Sapphire to connect to the EMu server.
Either, the previous config file may be used:
cd imu/config
cp ../../../sapphire-1.5.1/imu/config/local.php .
Or a new one created:
cd imu/config
vim local.php
- Add the following lines:
<?php
$config[“server-host”] = “emu.server.address”;
$config[“server-port”] = port;
?>
where emu.server.address is the name or IP address of the EMu server and port is the normal EMu server port number plus 20000, e.g. if the normal EMu port number is 20001, the Sapphire port is 40001.
- Configure local date formats if necessary. The default setting is to use the local date format. More information on the formats used for dates can be found at https://momentjs.com/docs/#/parsing/string-format/
The previous config file may be used:
cd imu/config
cp ../../../sapphire-1.5.1/imu/config/local.js .
Or a new one created:
vim local.js
The following lines reflect the default settings. If different date settings are to used, add the following two lines, adjust the format setting and save the file:
IMu.Config.defaultDateFormat = “L”;|
IMu.Config.serverDateFormat = “YYYY/MM/DD”;
- Prepare Sapphire for use:
cd ..
php imu.php
-
HTTP Server:
-
PHP:
- Version 5.0 or later
- DOM Extension for PHP
- Latest Sapphire release
Sapphire is designed to allow multiple installations to coexist. Each installation is placed in a directory and the name of this directory typically reflects the version of Sapphire being installed:
Sapphire should be installed as the same user as the previous version of Sapphire. The following covers an installation for user imu
:
- Login as user
imu
- Install Sapphire:
cd sapphire
mkdir sapphire-1.5.1
tar xzf sapphire-1.5.1.tgz sapphire-1.5.1
rm latest
ln -s sapphire-1.5.1 latest
- Modify the sapphire
index.html
file for improved response times:cd sapphire-1.5.1
vim index.html
- Find the following line:
<script type=”text/javascript” src=”imu/imu.php”></script>
and change
php
tojs
:<script type=”text/javascript” src=”imu/imu.js”></script>
- Configure Sapphire to connect to the EMu server.
Either, the previous config file may be used:
cd imu/config
cp ../../../sapphire-1.5.0/imu/config/local.php .
Or a new one created:
cd imu/config
vim local.php
- Add the following lines:
<?php
$config[“server-host”] = “emu.server.address”;
$config[“server-port”] = port;
?>
where emu.server.address is the name or IP address of the EMu server and port is the normal EMu server port number plus 20000, e.g. if the normal EMu port number is 20001, the Sapphire port is 40001.
- Configure local date formats if necessary. The default setting is to use the local date format. More information on the formats used for dates can be found at https://momentjs.com/docs/#/parsing/string-format/
The previous config file may be used:
cd imu/config
cp ../../../sapphire-1.5.0/imu/config/local.js .
Or a new one created:
vim local.js
The following lines reflect the default settings. If different date settings are to used, add the following two lines, adjust the format setting and save the file:
IMu.Config.defaultDateFormat = “L”;|
IMu.Config.serverDateFormat = “YYYY/MM/DD”;
- Prepare Sapphire for use:
cd ..
php imu.php
-
HTTP Server:
-
PHP:
- Version 5.0 or later
- DOM Extension for PHP
- Latest Sapphire release
Sapphire is designed to allow multiple installations to coexist. Each installation is placed in a directory and the name of this directory typically reflects the version of Sapphire being installed:
Sapphire should be installed as the same user as the previous version of Sapphire. The following covers an installation for user imu
:
- Login as user
imu
- Install Sapphire:
cd sapphire
mkdir sapphire-1.5.0
tar xzf sapphire-1.5.0.tgz sapphire-1.5.0
rm latest
ln -s sapphire-1.5.0 latest
- Modify the sapphire
index.html
file for improved response times:cd sapphire-1.5.0
vim index.html
- Find the following line:
<script type=”text/javascript” src=”imu/imu.php”></script>
and change
php
tojs
:<script type=”text/javascript” src=”imu/imu.js”></script>
- Configure Sapphire to connect to the EMu server.
Either, the previous config file may be used:
cd imu/config
cp ../../../sapphire-1.2.0/imu/config/local.php .
Or a new one created:
cd imu/config
vim local.php
- Add the following lines:
<?php
$config[“server-host”] = “emu.server.address”;
$config[“server-port”] = port;
?>
where emu.server.address is the name or IP address of the EMu server and port is the normal EMu server port number plus 20000, e.g. if the normal EMu port number is 20001, the Sapphire port is 40001.
- Configure local date formats if necessary. The default setting is to use the local date format. More information on the formats used for dates can be found at https://momentjs.com/docs/#/parsing/string-format/
The previous config file may be used:
cd imu/config
cp ../../../sapphire-1.2.0/imu/config/local.js .
Or a new one created:
vim local.js
The following lines reflect the default settings. If different date settings are to used, add the following two lines, adjust the format setting and save the file:
IMu.Config.defaultDateFormat = “L”;|
IMu.Config.serverDateFormat = “YYYY/MM/DD”;
- Prepare Sapphire for use:
cd ..
php imu.php
Upgrading Sapphire from any prior version of Sapphire to 1.2.0 will require some maintenance of existing Forms:
In some earlier versions of Sapphire, sections in a Form were saved without a unique ID. As a consequence, sections may be missing from a Form or the Form will simply be blank following an upgrade to 1.2.0.
IDs are now automatically generated when a Form is saved in the Form Designer and we recommend that all Forms are opened in the Form Designer and re-saved.
This is a relatively simple process:
Any Form with a custom layout will need to be rebuilt as the old format is not compatible with Sapphire 1.2.0.
Although a Form with a custom layout designed in an earlier version of Sapphire will be usable, the elements on the Form will be laid out sequentially rather than as designed, and it will be necessary to rebuild the custom layout.